.TH E1432_SET_OCTAVE_HOLD_MODE 3 E1432
.SH NAME
.nf
e1432_set_octave_hold_mode \- Set Octave hold mode
e1432_get_octave_hold_mode \- Get Octave hold mode
.IX e1432_set_octave_hold_mode(3) 3
.IX e1432_get_octave_hold_mode(3) 3
.SH SYNOPSIS
.cS
SHORTSIZ16 e1432_set_octave_hold_mode(E1432ID hw, SHORTSIZ16 ID,
                                      SHORTSIZ16 octave_hold_mode)
SHORTSIZ16 e1432_get_octave_hold_mode(E1432ID hw, SHORTSIZ16 ID,
                                      SHORTSIZ16 *octave_hold_mode)
.cE
.SH DESCRIPTION

\fIe1432_set_octave_hold_mode\fR sets the octave hold mode of the modules(s)
selected to the value given in \fIoctave_hold_mode\fR.

\fIe1432_get_octave_hold_mode\fR returns the octave hold mode state of the
modules(s) selected into a memory location pointed to by \fIoctave_hold_mode\fR.

This parameter is a "global" parameter.  It applies to an entire
module rather than to one of its channels.  The \fIID\fR parameter is
used only to identify which module the function applies to, and all
channels in that module will report the same value for this parameter.

\fIhw\fR must be the result of a successful call to
\fIe1432_assign_channel_numbers\fR, and specifies the group of
hardware to talk to.

\fIID\fR is either the ID of a group of channels that was obtained
with a call to \fIe1432_create_channel_group\fR, or the ID of a single
channel.
It is used to determine which module(s) in \fIhw\fR to set/query.

\fIoctave_hold_mode\fR must be either \fBE1432_OCTAVE_HOLD_MODE_OFF\fR,
or \fBE1432_OCTAVE_HOLD_MODE_MAX\fR.
\fBE1432_OCTAVE_HOLD_MODE_OFF\fR turns off Octave hold mode.
\fBE1432_OCTAVE_HOLD_MODE_MAX\fR selects the maximum value hold mode.

An octave hold mode of other than \fBE1432_OCTAVE_HOLD_MODE_OFF\fR
works only when the octave average mode,
selected by \fIe1432_set_octave_avg_mode\fR,
is set to \fBE1432_OCTAVE_AVG_MODE_EXP\fR.
Otherwise, it is ignored.

The hold mode computations begin place after the settling time, as
set by \fIe1432_set_filter_settling_time\fR.  Correct setting of
filter_settling_time is essential for valid Octave hold mode results.

For implementation reasons, the Octave results returned by
\fIe1432_get_current_data\fR may be either the instantaneous Octave data or
hold mode data, depending on what is most recently available.

.SH "RESET VALUE"
After a reset, \fIoctave_hold_mode\fR is set to
\fBE1432_OCTAVE_HOLD_MODE_OFF\fR.
.SH "RETURN VALUE"
Return 0 if successful, a (negative) error number otherwise.
.SH "SEE ALSO"
.na
e1432_set_octave_mode,
e1432_set_octave_avg_mode,
e1432_set_octave_start_freq, e1432_set_octave_stop_freq,
e1432_set_octave_int_time,
e1432_set_octave_time_const,
e1432_set_octave_time_step,
e1432_octave_ctl,
e1432_get_octave_blocksize,
e1432_get_current_data
e1432_set_filter_settling_time
.ad
